GroupAreaOptions Object

The GroupAreaOptions Object provides properties for retrieving information and setting options for a group area found in a report (that is, keep group together, sort direction, etc.). A GroupAreaOptions Object is obtained from the GroupOptions property of the Area Object.

GraphAreaOptions Object Properties

Property Description Read/Write

Application

Returns a reference to the Application Object, that this object is associated with.

Read only

Condition

Returns/Sets CRGroupCondition (see table below) indicating when grouping should occur for Boolean or Date groups (that is, for Boolean groups, group on change to TRUE; for date groups, group dates weekly, etc.).

Read/Write


Constant Value


crGCAnnually

7


crGCAnyValue

14


crGCBiweekly

2


crGCDaily

0


crGCEveryNo

11


crGCEveryYes

10


crGCMonthly

4


crGCNextIsNo

13


crGCNextIsYes

12


crGCQuarterly

5


crGCSemiAnnually

6


crGCSemiMonthly

3


crGCToNo

9


crGCToYes

8


crGCWeekly

1

Property Description Read/Write

ConditionField

Returns/Sets DatabaseFieldDefinition Object, specifying the field that grouping occurs on.

Read/Write

DiscardOther
Groups

Returns/Sets Boolean value indicating if "other" groups in a group sort are discarded (that is, those not included in a Top/Bottom N group sort when sorting groups by their summary field).

Read/Write

KeepGroupTogether

Returns/Sets Boolean value to keep group together (that is, across page breaks).

Read/Write

NumberOfTopOr
BottomGroups

Returns/Sets the number of groups for a TopN group sort.

Read/Write

Parent

Reference to the Parent object (Area Object).

Read only

RepeatGroup
Header

Returns/Sets Boolean value indicating if group headers should be repeated when group is split across pages.

Read/Write

Report

Reference to Report Object.

Read only

SortDirection

Returns/Sets CRSortDirection (see table below) indicating the sort direction of the group name field, as opposed to the group summary field.

Read/Write


Constant Value


crAscendingOrder

1


crDescendingOrder

0


crOriginalOrder

2


crSpecifiedOrder
(Read only -- this value cannot be set.)

3

Property Description Read/Write

TopOrBottomN
Groups

Returns/Sets the value of CRTopBottomNGroupSortOrder (see table below) indicating which section of groups will be shown (that is, TopN groups, BottomN groups, all groups, etc.).

Read/Write


Constant Value


crAllGroupsSorted.

1


crAllGroupsUnsorted

0


crBottomNGroups

3


crTopNGroups

2



Seagate Software IMG Holdings, Inc.
http://www.seagatesoftware.com
Support services:
http://support.seagatesoftware.com